leaflet hello world

本篇博客主要讲的 spring 如何初始化其上下文的源码简单解读。

web.xml

web.xml 即应用程序部署描述符文件，其中包含了应用程序需要初始化的组件，比如 Filter、Listener、Servle、欢迎页、session配置等。

• web.xml tomcat官网介绍 https://tomcat.apache.org/tomcat-7.0-doc/appdev/deployment.html
• web.xml 介绍 https://blog.csdn.net/ckc_666/article/details/82964812

ContextLoaderListener

<context-param>标签，用于配置一个全局变量，spring ContextLoaderListener 会使用到这个全局变量，

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring.xml</param-value>
    </context-param>
    <listener>
        <description>spring监听器</description>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

ContextLoaderListener 实现了 ServletContextListener 接口。ServletContextListener 接口够监听 ServletContext 对象的生命周期，实际上就是监听 Web 应用的生命周期。当 Servlet 容器启动或终止 Web 应用时，会触发 ServletContextEvent 事件，该事件由 ServletContextListener 来处理。在web容器启动时会触发 ContextLoaderListener 中的 contextInitialized 方法。

ContextLoaderListener 代码如下

public class ContextLoaderListener extends ContextLoader implements ServletContextListener {
    public ContextLoaderListener() {
    }

    public ContextLoaderListener(WebApplicationContext context) {
        super(context);
    }

    public void contextInitialized(ServletContextEvent event) {
        //调用这个方法，看名字就知道是初始化 spring 的上下文
        this.initWebApplicationContext(event.getServletContext());
    }

    public void contextDestroyed(ServletContextEvent event) {
        this.closeWebApplicationContext(event.getServletContext());
        ContextCleanupListener.cleanupAttributes(event.getServletContext());
    }
}

ContextLoader.initWebApplicationContext

 public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
       // 先判断 ServletContext 中是否已存在上下文，存在说明已加载或配置信息有误
        if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
            throw new IllegalStateException("Cannot initialize context because there is already a root application context present - check whether you have multiple ContextLoader* definitions in your web.xml!");
        } else {

            ...

            try {
                if (this.context == null) {
                    //创建 WebApplicationContext
                    this.context = this.createWebApplicationContext(servletContext);
                }

                if (this.context instanceof ConfigurableWebApplicationContext) {
                    //如果 this.context 是 ConfigurableWebApplicationContext 的实例，则配置并刷新 WebApplicationContext
                    ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext)this.context;
                    if (!cwac.isActive()) {
                        if (cwac.getParent() == null) {
                            ApplicationContext parent = this.loadParentContext(servletContext);
                            cwac.setParent(parent);
                        }

                        this.configureAndRefreshWebApplicationContext(cwac, servletContext);
                    }
                }
                //将 WebApplicationContext 放入 servletContext 中，供后续流程使用
                servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
                ClassLoader ccl = Thread.currentThread().getContextClassLoader();
                if (ccl == ContextLoader.class.getClassLoader()) {
                    currentContext = this.context;
                } else if (ccl != null) {
                    currentContextPerThread.put(ccl, this.context);
                }

                ...

                return this.context;
            } catch (RuntimeException var8) {
                logger.error("Context initialization failed", var8);
                servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, var8);
                throw var8;
            } catch (Error var9) {
                logger.error("Context initialization failed", var9);
                servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, var9);
                throw var9;
            }
        }
    }

ContextLoader.configureAndRefreshWebApplicationContext

配置和刷新上下文，主要是设置容器 id 和获得配置文件路径

    protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
        String configLocationParam;
        //检查并设置容器 id
        if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
            configLocationParam = sc.getInitParameter("contextId");
            //如果配置文件配置了容器 id，使用配置的容器 id
            if (configLocationParam != null) {
                wac.setId(configLocationParam);
            } else {
                wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX + ObjectUtils.getDisplayString(sc.getContextPath()));
            }
        }

        wac.setServletContext(sc);
        //获取 spring 配置文件，我们在 web.xml 里有配置
        configLocationParam = sc.getInitParameter("contextConfigLocation");
        if (configLocationParam != null) {
            wac.setConfigLocation(configLocationParam);
        }

        ConfigurableEnvironment env = wac.getEnvironment();
        if (env instanceof ConfigurableWebEnvironment) {
            ((ConfigurableWebEnvironment)env).initPropertySources(sc, (ServletConfig)null);
        }
        //用户自定义上下文，这里暂时不讲
        this.customizeContext(sc, wac);
        //刷新上下文，读取配置文件，解析bean定义，注册BeanDefinition，实例化bean，完成注入的过程
        wac.refresh();
    }

AbstractApplicationContext.refresh()

refresh() 方法的实现类是抽象类 AbstractApplicationContext，继承了 ConfigurableApplicationContext 等接口。

refresh() 做了所有的上下文初始化动作，包括获取 BeanFactory，处理 BeanFactory，实例化 bean 等。

    public void refresh() throws BeansException, IllegalStateException {
        synchronized(this.startupShutdownMonitor) {
            //容器刷新前准备工作
            this.prepareRefresh();
            //启动 obtainFreshBeanFactory 里的 refreshBeanFactory() 方法
            //主要是把旧的 beanFactory 关闭，重新创建一个 beanFactory
            ConfigurableListableBeanFactory beanFactory = this.obtainFreshBeanFactory();
            this.prepareBeanFactory(beanFactory);

            try {
                this.postProcessBeanFactory(beanFactory);
                this.invokeBeanFactoryPostProcessors(beanFactory);
                this.registerBeanPostProcessors(beanFactory);
                this.initMessageSource();
                this.initApplicationEventMulticaster();
                this.onRefresh();
                this.registerListeners();
                this.finishBeanFactoryInitialization(beanFactory);
                this.finishRefresh();
            } catch (BeansException var9) {
                if (this.logger.isWarnEnabled()) {
                    this.logger.warn("Exception encountered during context initialization - cancelling refresh attempt: " + var9);
                }

                this.destroyBeans();
                this.cancelRefresh(var9);
                throw var9;
            } finally {
                this.resetCommonCaches();
            }

        }
    }

接下来

接下来我们讲 beanFactory 的获取。<>

---

转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 rockeycui@163.com